.\" Copyright (C) 2007 International Business Machines Corporation
.\" Written by Ramon Brandão based on the Trusted Computing Group Software Stack Specification Version 1.2
.\"
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "Tspi_TPM_Quote2" 3 "2007-04-03" "TSS 1.2" "TCG Software Stack Developer's Reference"
.SH NAME
Tspi_TPM_Quote2 \- retreive a signed set of PCR values with a more complete view than Tspi_TPM_Quote.
.SH "SYNOPSIS"
.ad l
.hy 0
.nf
.B #include <tss/platform.h>
.B #include <tss/tcpa_defines.h>
.B #include <tss/tcpa_typedef.h>
.B #include <tss/tcpa_struct.h>
.B #include <tss/tss_typedef.h>
.B #include <tss/tss_structs.h>
.B #include <tss/tspi.h>
.sp
.BI "TSS_RESULT Tspi_TPM_Quote2(TSS_HTPM  " hTPM ",          TSS_HKEY        " hIdentKey ","
.BI "                          TSS_BOOL   " fAddVersion ",     TSS_HPCRS   " hPcrComposite ","
.BI "                          TSS_VALIDATION* " pValidationData ", UINT32* " versionInfoSize ","
.BI "                          BYTE**  " versionInfo ");"
.fi
.sp
.ad
.hy
.SH "DESCRIPTION"
.PP
\fBTspi_TPM_Quote2\fR quotes a TCG system, providing the requestor 
with a more complete view of the current platform configuration,
than \fBTspi_TPM_Quote\fR.

.SH "PARAMETERS"
.PP
.SS hTPM
Handle of the TPM object.
.PP
.SS hIdentKey
Handle of the signature key object.
.PP
.SS fAddVersion
If TRUE, the TPM version is added to the output. If FALSE, the TPM version 
isn't added to the output.
.PP
.SS hPcrComposite
Handle of the PCR composite object, which contains the PCRs to be quoted.
.PP
.SS pValidationData
Validation data structure
[IN] Provide externalData information required to compute the signature.
[OUT] On successful completion of the command, the structure provides a buffer containing the validation data and a buffer containing the data the validation data was computed form.
.PP
.SS versionInfoSize
The size of the bytestream returned by versionInfo. If the \fIfAddVersion\fR is False
this is zero.
.PP
.SS versionInfo
The version information returned as a byte stream reflecting the data in 
TSS_CAP_VERSION_INFO if the fAddVersion is TRUE. Else it's NULL.
.PP 

.SH "RETURN CODES"
.PP
\fBTspi_TPM_Quote\fR returns TSS_SUCCESS on success, otherwise one of the following values are returned:
.TP
.SM TSS_E_INVALID_HANDLE - \fIhTPM\fR, \fIhIdentKey\fR or \fIhPcrComposite\fR is not a valid handle.
.TP
.SM TSS_E_BAD_PARAMETER
.TP
.SM TSS_E_INTERNAL_ERROR - An error occurred internal to the TSS.

.SH "CONFORMING TO"

.PP
\fBTspi_TPM_Quote2\fR conforms to the Trusted Computing Group Software Specification version 1.2
.SH "SEE ALSO"

.PP
\fBTspi_TPM_Quote\fR(3).



